410 enforce a html formatter and linter #411
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…jango HTML linting and formatting
4 tasks
|
@mbarton What are your thoughts on adding linting/formatting to pre-commits or PR checks? By default, djlint does not return a non-zero exit code for lint issues. If you want to fail the pipeline on linting errors, we'd have to run djlint without the --reformat flag and handle warnings as errors?... With this in the pipeline, templates with broken HTML would be prevented from being pushed to live. Thinking wider than template .html files, there's MegaLinter that has black and djlint capabilities... |
|
Seen on STAGING (created by @reecehill and merged by @eatyourpeas 9 minutes and 44 seconds ago) Please check your changes! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This pull request includes updates to configuration files, documentation, and HTML templates to enhance code formatting, linting, and developer experience. The most important changes include the addition of a new configuration file for DJLint, updates to VSCode settings and recommendations, and improvements to HTML templates for better readability and consistency.
Configuration Updates:
.djlintrcconfiguration file to enforce specific formatting and linting rules for Django templates..vscode/settings.jsonto include settings for Python language server, file associations, editor configurations, and DJLint integration..vscode/extensions.jsonto recommend extensions for spell checking, Python formatting, Django support, and linting.Documentation Improvements:
code-style.mdwith detailed instructions for linting and formatting Python files and Django templates, including usage of DJLint. [1] [2] [3]HTML Template Enhancements:
Developer experience
As per documentation, developers are to continue to using VSCode. No change there.
However, .vscode/extensions.json will advise devs which extensions to have installed (optional). The biggest recommendation added in this PR is the use of "djlint" for linting and formatting Django template files.
To run djlint:
djlint ./project/npda/templates/* --configuration .djlintrc --reformatdjlint ./project/npda/templates/* --configuration .djlintrc --lintOther linters
I had considered other methods of linting template files with django tags ({{ }}). Including "Django Template Support" and Prettier. The first does a great job, but offers no CLI utility (thinking CI/CD), and Prettier - whilst ideal for tailwindcss management - cannot handle Django tags.